boot/grub2: Add some more explanation in ostree-grub-generator

Even with the previous docstring, I didn't understand at first the
relationship between the `ostree-grub-generator` script and
`ostree-bootloader-grub2.c`. Throw some more docs to clarify things a
bit.

Closes: #1791
Approved by: cgwalters

diff --git a/src/boot/grub2/ostree-grub-generator b/src/boot/grub2/ostree-grub-generator
index 5b7ea1ab933fbe7c88aab60c9d8badee44ea5d6c..2208c1bfc1c1899b52847d155dd5083fb384d2ab 100644 (file)
--- a/src/boot/grub2/ostree-grub-generator
+++ b/src/boot/grub2/ostree-grub-generator
@@ -1,11 +1,12 @@
 #!/bin/sh
 
-# The builtin grub.cfg generator.
+# The builtin grub.cfg generator. This script is called by
+# ostree/src/libostree/ostree-bootloader-grub2.c whenever boot loader
+# configuration file needs to be updated on systems which do not use
+# grub2-mkconfig (and thus, the `ostree admin instutil grub2-generate` path).
 #
-# This script is called by ostree/src/libostree/ostree-bootloader-grub2.c whenever
-# boot loader configuration file needs to be updated. It can be used as a template
-# for a custom grub.cfg generator. What to consider when writing a custom grub.cfg
-# generator:
+# It can be used as a template for a custom grub.cfg generator. What to consider
+# when writing a custom grub.cfg generator:
 #
 #   - The populate_menu() function converts boot loader entries as defined by
 #   https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/ into GRUB2